Appliance Recovery Backup Schedules Info

Appliance Recovery Backup Schedules Info
Appliance Recovery Backup Schedules Info

The Appliance Recovery Backup Schedules Info schema contains information about an existing schedule. The structure includes Schedule ID, parts, location information, encryption password, enable flag, recurrence and retention information.

This schema was added in vSphere API 6.7.

JSON Example
{
    "parts": [
        "string"
    ],
    "location": "string",
    "location_user": "string",
    "enable": false,
    "recurrence_info": {
        "minute": 0,
        "hour": 0,
        "days": [
            "string"
        ]
    },
    "retention_info": {
        "max_count": 0
    },
    "fast_backup": false
}
array of string
parts
Required

List of optional parts that will be included in backups based on this schedule details. Use the GET /appliance/recovery/backup/parts operation to get information about the supported parts.

This property was added in vSphere API 6.7.

string As uri As uri
location
Required

URL of the backup location.

This property was added in vSphere API 6.7.

string
location_user
Optional

Username for the given location.

This property was added in vSphere API 6.7.

If missing or null location user will not be used.

boolean
enable
Required

Enable or disable a schedule, by default when created a schedule will be enabled.

This property was added in vSphere API 6.7.

recurrence_info
Optional

Recurrence information for the schedule.

This property was added in vSphere API 6.7.

If missing or null backup job is not scheduled. See Appliance Recovery Backup Schedules RecurrenceInfo

retention_info
Optional

Retention information for the schedule.

This property was added in vSphere API 6.7.

If missing or null all the completed backup jobs are retained forever. See Appliance Recovery Backup Schedules RetentionInfo

boolean
fast_backup
Optional

Option to enable Postgres DB/ VCDB fast backup

This property was added in vSphere API 6.7.

If missing or null backup will proceed at slow rate

Returned By